<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
 <head>
  <meta http-equiv="content-type" content="text/html; charset=UTF-8">
  <title>List all the subscribed mailboxes</title>

 </head>
 <body><div class="manualnavbar" style="text-align: center;">
 <div class="prev" style="text-align: left; float: left;"><a href="function.imap-getmailboxes.html">imap_getmailboxes</a></div>
 <div class="next" style="text-align: right; float: right;"><a href="function.imap-header.html">imap_header</a></div>
 <div class="up"><a href="ref.imap.html">IMAP 函数</a></div>
 <div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.imap-getsubscribed" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">imap_getsubscribed</h1>
  <p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">imap_getsubscribed</span> &mdash; <span class="dc-title">List all the subscribed mailboxes</span></p>

 </div>
 <div class="refsect1 description" id="refsect1-function.imap-getsubscribed-description">
  <h3 class="title">说明</h3>
  <div class="methodsynopsis dc-description">
   <span class="type">array</span> <span class="methodname"><strong>imap_getsubscribed</strong></span>
    ( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$imap_stream</code></span>
   , <span class="methodparam"><span class="type">string</span> <code class="parameter">$ref</code></span>
   , <span class="methodparam"><span class="type">string</span> <code class="parameter">$pattern</code></span>
   )</div>

  <p class="para rdfs-comment">
   Gets information about the subscribed mailboxes.
  </p>
  <p class="para">
   Identical to <span class="function"><a href="function.imap-getmailboxes.html" class="function">imap_getmailboxes()</a></span>, except that it only
   returns mailboxes that the user is subscribed to.
  </p>
 </div>

 <div class="refsect1 parameters" id="refsect1-function.imap-getsubscribed-parameters">
  <h3 class="title">参数</h3>
  <p class="para">
   <dl>

    <dt>
<em><code class="parameter">
imap_stream</code></em></dt>
<dd>
<p class="para">由 <span class="function"><a href="function.imap-open.html" class="function">imap_open()</a></span> 返回的 IMAP 流。</p></dd>

    
     <dt>
<em><code class="parameter">ref</code></em></dt>

     <dd>

      <p class="para">
       <em><code class="parameter">ref</code></em> should normally be just the server
       specification as described in <span class="function"><a href="function.imap-open.html" class="function">imap_open()</a></span>
      </p>
     </dd>

    
    
     <dt>
<em><code class="parameter">pattern</code></em></dt>

     <dd>

      <p class="para">指定在邮箱层级的何处开始查找。</p>
<p class="para">在组成 <em><code class="parameter">pattern</code></em> 的字符中可使用两个特殊字符：
 &#039;<em>*</em>&#039; 和 &#039;<em>%</em>&#039;。
 &#039;<em>*</em>&#039; 是指返回所有邮箱目录. 如果将 &#039;<em>*</em>&#039; 作为
 <em><code class="parameter">pattern</code></em> 参数时, 则会返回整个邮箱层级结构。
 &#039;<em>%</em>&#039; 是指只返回当前级次。
 &#039;<em>%</em>&#039; 作为 <em><code class="parameter">pattern</code></em> 参数则只会返回顶层邮箱；
 &#039;<em>~/mail/%</em>&#039; 用于 <em>UW_IMAPD</em>
 则会返回名为 <var class="filename">~/mail</var> 的目录, 但不包含其子目录。</p>
     </dd>

    
   </dl>

  </p>
 </div>

 <div class="refsect1 returnvalues" id="refsect1-function.imap-getsubscribed-returnvalues">
  <h3 class="title">返回值</h3>
  <p class="para">
   Returns an array of objects containing mailbox information. Each
   object has the attributes <em><code class="parameter">name</code></em>, specifying
   the full name of the mailbox; <em><code class="parameter">delimiter</code></em>,
   which is the hierarchy delimiter for the part of the hierarchy
   this mailbox is in; and
   <em><code class="parameter">attributes</code></em>. <em><code class="parameter">Attributes</code></em>
   is a bitmask that can be tested against:
   <ul class="itemizedlist">
    <li class="listitem">
     <span class="simpara">
      <strong><code>LATT_NOINFERIORS</code></strong> - This mailbox has no
      &quot;children&quot; (there are no mailboxes below this one).
     </span>
    </li>
   <li class="listitem">
     <span class="simpara">
      <strong><code>LATT_NOSELECT</code></strong> - This is only a container,
      not a mailbox - you cannot open it.
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <strong><code>LATT_MARKED</code></strong> - This mailbox is marked.
      Only used by UW-IMAPD.
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <strong><code>LATT_UNMARKED</code></strong> - This mailbox is not marked.
      Only used by UW-IMAPD.
     </span>
    </li>
   </ul>
  </p>
 </div>

</div><hr /><div class="manualnavbar" style="text-align: center;">
 <div class="prev" style="text-align: left; float: left;"><a href="function.imap-getmailboxes.html">imap_getmailboxes</a></div>
 <div class="next" style="text-align: right; float: right;"><a href="function.imap-header.html">imap_header</a></div>
 <div class="up"><a href="ref.imap.html">IMAP 函数</a></div>
 <div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
